home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / netutils / netelect.arj / READ.ME < prev   
Text File  |  1994-02-04  |  26KB  |  580 lines
  1.                                NetElect
  2.                               ----------
  3.  
  4.  
  5.                           ON-LINE HELP FILE
  6.                           -----------------
  7.  
  8.   Use arrow keys, page-up, page-down to view.  Any key to exit.
  9.  
  10.   TOPICS:
  11.  
  12.                 1 -  NEALARM.EXE
  13.                 2 - NETELECT.EXE
  14.                 2.1 - LOGINS:
  15.                 2.1.1 - New Accounts:
  16.                 2.1.2 - Existing Accounts:
  17.                 2.3 - BASE SCREEN:
  18.                 2.4 - SYSTEM MENU:
  19.                 2.4.1 - Login
  20.                 2.4.2 - Change password
  21.                 2.4.3 - Configure
  22.                 2.4.4 - Video
  23.                 2.4.5 - Dos Shell
  24.                 2.4.6 - Exit
  25.                 2.5 - ISSUES MENU:
  26.                 2.5.1 - All
  27.                 2.5.2 - Current
  28.                 2.5.3 - Open
  29.                 2.5.4 - Closed
  30.                 2.5.5 - Yours
  31.                 2.5.6 - Referee
  32.                 2.5.7 - Create
  33.                 2.6 - ISSUE CREATION
  34.                 2.6.1 - Edit screen
  35.                 2.6.2 - Referee selection
  36.                 2.6.3 - Selection size entry
  37.                 2.6.4 - Invitations
  38.                 2.7 - ISSUES DISPLAY
  39.                 2.8 - REFEREE AN ISSUE
  40.                 2.9 - VOTERS MENU
  41.                 2.10 - HELP MENU
  42.  
  43.   NetElect is a database system that allows users of a network to vote
  44.   on issues among themselves and to be notified when an issue is
  45.   created or settled.  Accounts are maintained for each user with a
  46.   hierarchy of privilege and a modicum of security.  Issues may be of
  47.   binary type or of selection type, public or private. Multiple users
  48.   can access the database simultaneously.
  49.  
  50.   NetElect is written in Borland C++ 3.1 using the TurboVision
  51.   application framework.  It runs under DOS, can use but does not
  52.   require a mouse, can use but does not require a color monitor.
  53.  
  54.   NetElect is a shareware product and, as such, is provided at no charge
  55.   to the user for evaluation.  If you find this program useful and
  56.   find that you are using NetElect after a 30 day trial period, you
  57.   should make a registration payment of $20.00 to the author:
  58.  
  59.                 Ron Mignery
  60.                 85 Bartlett Street
  61.                 Somerville, MA 02145
  62.  
  63.  
  64.   The $20.00 registration fee will license one copy for use on any one
  65.   network at any time.  Registered users will receive updates
  66.   of the program on request as they become available.  What a deal!
  67.  
  68.   This is an intial release of the program and the author is still
  69.   struggling with TurboVision so please excuse awkward phraseologies
  70.   and interfaces.  Any comments on the program would be more than
  71.   welcome.
  72.  
  73.   A similar product, NetBet, exists to allow network users to place
  74.   bets among themselves and to be notified when a bet is created or
  75.   settled.
  76.  
  77.   A Windows version will follow someday.
  78.  
  79.   Two executables constitute the release:  NETELECT.EXE and NEALARM.EXE
  80.   These files must be in the execution path of all users.  All users
  81.   must further have read/write access to a common data subdirectory to
  82.   which they log or to which they point with an environmental variable,
  83.   NETELECT.  Various data files will be created in this subdirectory
  84.   as NetElect executes.
  85.  
  86.   A third file, READ.ME, (this file) should be placed in all NetElect
  87.   data subdirectories.
  88.  
  89.  
  90.   1 -  NEALARM.EXE------------------------------------------------------
  91.  
  92.   NEALARM is intended to be executed in the login script of a network
  93.   user.  It scans a file of notices and signals the user when an issue
  94.   creator has issued an invitation to that particular user or when that
  95.   user has been assigned to settle an issue and the settlement date has
  96.   arrived.  It then removes that notice from the file so be aware that
  97.   notices are only given once.
  98.  
  99.   The user's NetElect account # must be passed as a parameter to
  100.   NEALARM.EXE.  The user may also pass switches to suppress sound
  101.   generation or to require a key press after each notification.
  102.  
  103.  
  104.   Usage:  NEALARM [-sw] <account #>
  105.  
  106.         Switches:
  107.            -s   No sound
  108.            -w   Wait for key press
  109.  
  110.  
  111.   Usage example:
  112.  
  113.         ...inserted in login script...
  114.                 SHARE
  115.                 SET NETELECT=C:\NETELECT
  116.                 NEALARM -SW 13
  117.         ...
  118.  
  119.  
  120.   Of course, NEALARM can also be executed outside a script at any time.
  121.  
  122.   When user 0 (the program manager) executes NEALARM, the notification
  123.   file is packed to remove expired notices.
  124.  
  125.  
  126.   2 - NETELECT.EXE---------------------------------------------------------
  127.  
  128.   Netelect.exe is executed by the user to place, review, create and
  129.   referee issues.  DOS share.exe should previously have been executed
  130.   for networks that do not obviate its usage.
  131.  
  132.   Usage:      [SHARE ]
  133.                NETELECT
  134.  
  135.   It may be desirable to enter the program through a batch procedure
  136.   that could execute share, set the NETELECT environmental variable, and
  137.   execute netelect.  Multiple NetElect systems could then be installed on
  138.   a single network with multiple batch procedures (bat files), each
  139.   specifying a different subdirectory through the the NETELECT variable
  140.   for data files.
  141.  
  142.  
  143.  
  144.   2.1 - LOGINS:
  145.  
  146.   Upon progam initiation, the user is requested to enter a name
  147.   (not case sensitive).  The user need enter no more characters
  148.   than necessary to unambiguously identify an account.
  149.  
  150.   2.1.1 - New Accounts:
  151.  
  152.           If no accounts have yet been created then the first name
  153.           entered identifies the program manager account.
  154.  
  155.           Otherwise, if the name entered does not match the name for
  156.           existing accounts, the user is either denied access or
  157.           allowed to create an account depending on system
  158.           configuration options available only to the program manager.
  159.  
  160.           If the user then chooses to create a new account, the
  161.           program will ask for for a password (11 character maximum)
  162.           for the account.
  163.  
  164.   2.1.2 - Existing Accounts:
  165.  
  166.           If the name entered does match the name for existing account,
  167.           the user will then be asked for the password for the account.
  168.  
  169.  
  170.  
  171.   2.3 - BASE SCREEN:
  172.  
  173.   After the login, the user is presented with the base screen:
  174.  
  175.  
  176.       ┌───────────┬──────────┬────────────┬─────────────────────────────┐
  177.       │System     │Issues    │Voters      │Help                         │
  178.       ├───────────┴──────────┴────────────┴─────────────────────────────┤
  179.       │                                          Thurs Oct 12 10:12:03  │
  180.       │                                                                 │
  181.       │  ACCOUNT INFO for #1 John Q. Public             SYSTEM INFO     │
  182.       │   ----------------       ╔╗╔╦═╦═ ║              -----------     │
  183.       │                          ║║║╠═╠══║╔═╦═╦═        # Voters     :7 │    
  184.       │                          ║║║╩═╠══║╠═║ ║         # Categories :1 │    
  185.       │                          ║╚╝  ╚══╩╩═╩═║         # Issues     :1 │    
  186.       │                                                                 │
  187.       ├─────────────────────────────────────────────────────────────────┤
  188.       │                                                                 │
  189.       │                                                                 │
  190.       │                                                                 │
  191.       │                                                                 │
  192.       │                                                                 │
  193.       │                                                                 │
  194.       │                                                                 │
  195.       │                                                                 │
  196.       │                                                                 │
  197.       │                                                                 │
  198.       │                                                                 │
  199.       │                                                                 │
  200.       │                                                                 │
  201.       ├─────────────────────────────────────────────────────────────────┤
  202.       │ Alt-X exit                                                      │
  203.       └─────────────────────────────────────────────────────────────────┘
  204.  
  205.   The top line is a menu bar from which menus may be activated by
  206.   clicking with the mouse or by pressing the ALT key along with the
  207.   highlighted letter of the desired menu.  Or F10 may be pressed and
  208.   the menu selected with the left-right arrow keys and activated by the
  209.   ENTER key.
  210.  
  211.   The current user account number and name are displayed.  This number
  212.   is the one to be used with NEALARM as described above.
  213.  
  214.   On the right are displayed the total number of voters, number of
  215.   categories of issues and the number of issues (outcomes) currently in
  216.   the system.
  217.  
  218.  
  219.   2.4 - SYSTEM MENU:
  220.  
  221.   The SYSTEM menu presents the following selections:
  222.  
  223.                 ┌───────────────────────────┐
  224.                 │ Login                     │
  225.                 │ Change password           │
  226.                 ├───────────────────────────┤
  227.                 │ Configure                 │
  228.                 │ Video                     │
  229.                 │ Dos Shell                 │
  230.                 │ Exit                      │
  231.                 └───────────────────────────┘
  232.  
  233.  
  234.  
  235.   In all menus, the mouse or an arrows key is used to selected the
  236.   desired action and the mouse button or the ENTER key is then pressed.
  237.   The ESC key aborts.
  238.  
  239.  
  240.   2.4.1 - Login - Presents the same dialog as for program initiation to enter
  241.           the user into another account.
  242.  
  243.   2.4.2 - Change password - Presents a same dialog for the user to change
  244.           the password of the current account.
  245.  
  246.   2.4.3 - Configure - Sets system options (only available to the program
  247.           manager).  Presents the following dialog:
  248.  
  249.             ┌──────────────────────────────────────────────────┐
  250.             │                                                  │
  251.             │     Options:                                     │
  252.             │ [ ] Disallow New Accounts                        │
  253.             │ [ ] Create Issue Privilege for New Accounts      │
  254.             │ [ ] Create Category Privilege for New Accounts   │
  255.             │ [ ] Referee Issue Privilege for New Accounts     │
  256.             │                                                  │
  257.             │ Starting money: $ 100.00                         │
  258.             │                                                  │
  259.             └──────────────────────────────────────────────────┘
  260.  
  261.   In all dialog screens, the TAB key is used to move between fields.
  262.   SHIFT-TAB moves backwards.  When the options checkbox field is
  263.   selected, arrows move among checkboxes and the SPACE BAR toggles
  264.   the selections on and off.  An X in the check box indicates that
  265.   the option is active. ENTER accepts and closes the dialog.  ESC
  266.   aborts.
  267.  
  268.   2.4.3.1 - Descriptions of Configure options:
  269.  
  270.             Disallow New Accounts - If login name not found, program
  271.             exits rather than allow a new account to be created.
  272.  
  273.             Create Issue Privilege for New Accounts - Allows a new
  274.             account user to create issues in the system.
  275.  
  276.             Create Category Privilege for New Accounts - Allows a new
  277.             account user to create new categories of issues in the system.
  278.  
  279.             Referee Issue Privilege for New Accounts - Allows a new
  280.             account user to settle issues in the system.
  281.  
  282.   2.4.3.2 - Starting money - When the Starting money field is
  283.             selected, the manager may then enter the initial amount of
  284.             available money in new accounts.
  285.  
  286.   2.4.4 - Video - Switches between 25 and 50 (or 43) line mode on VGA
  287.           displays.
  288.  
  289.   2.4.5 - Dos Shell - Exits program to a shell.  Entering EXIT at the DOS
  290.           prompt will return the user to the program.
  291.  
  292.   2.4.6 - Exit - Exits program.  Pressing Alt-X or clicking on Alt-X
  293.           on the status line does the same.
  294.  
  295.  
  296.   2.5 - ISSUES MENU:
  297.  
  298.   The ISSUES menu presents the following selections:
  299.  
  300.  
  301.                 ┌───────────────────┐
  302.                 │  All           F2 │
  303.                 │  Current       F3 │
  304.                 │  Open          F4 │
  305.                 │  Closed           │
  306.                 │  Settled          │
  307.                 │  Yours            │
  308.                 ├───────────────────┤
  309.                 │  Referee       F5 │
  310.                 │  Create        F6 │
  311.                 └───────────────────┘
  312.  
  313.  
  314.   For any selection on this menu, the user must then select a
  315.   category from a pick list of existing categories.  For create an issue,
  316.   the user also has the option of creating a new category on the list.
  317.   Note that the user must have create category privilege to create a
  318.   new category and create issue privilege to create an issue.
  319.  
  320.  
  321.   2.5.1 - All - Scans all issues in the selected category.  F2 is a hot
  322.           key for this selection.
  323.  
  324.   2.5.2 - Current - Scans all issues in the selected category on which
  325.           the user has cast votes or has been invited to vote.  F3 is a
  326.           hot key for this selection.
  327.  
  328.   2.5.3 - Open - Scans all issues in the selected category on which votes
  329.           may be cast (later than start date, earlier than close
  330.           date).  F4 is a hot key for this selection.
  331.  
  332.   2.5.4 - Closed - Scans all issues in the selected category on which
  333.           votes may not be cast (earlier than start date, later than
  334.           close date).
  335.  
  336.   2.5.5 - Settled - Scans all issues in the selected category that have
  337.           been settled and not yet reused for new issues.
  338.  
  339.   2.5.6 - Yours - Scans all issues in the selected category for which
  340.           the user is the author.
  341.  
  342.   2.5.7 - Referee - Scans all issues in the selected category for which
  343.           the user has been designated as the referee.  (The program
  344.           manager can referee any issue regardless of the designated
  345.           referee.)  F5 is a hot key for this selection.
  346.  
  347.   2.5.8 - Create - Allows the user to create a new issue in the selected
  348.           category. (Requires create issue privilege.)  F6 is a hot key
  349.           for this selection.
  350.  
  351.  
  352.   2.6 - ISSUE CREATION
  353.  
  354.   2.6.1 - Edit screen
  355.  
  356.   A issue is created in the following dialog:
  357.  
  358.  ╔═[■]══════════════════════════ Create an Issue ═════════════════════════╗
  359.  ║   Author: <account name>                                               ║
  360.  ║   Category: <category>                                                 ║
  361.  ║                              Outcome                                   ║
  362.  ║    ┌────────────────────────────────────────────────────────────┐      ║
  363.  ║    │<enter  a description of the issue as a possible outcome.>  │      ║
  364.  ║    │                                                            │      ║
  365.  ║    │                                                            │      ║
  366.  ║    │                                                            │      ║
  367.  ║    └────────────────────────────────────────────────────────────┘      ║
  368.  ║    Access                                Type                          ║
  369.  ║    [ ] Private (specify participants)    ( ) Yes/No                    ║
  370.  ║    [ ] Secret (votes not displayed)      () Selection                 ║
  371.  ║                                                                        ║
  372.  ║                  YYYY/MM/DD-HH                                         ║
  373.  ║    Start Date:   1994/02/04-12                                         ║
  374.  ║    End Date  :   1995/02/04-12                                         ║
  375.  ║    Settlement:   1994/02/04-12                                         ║
  376.  ║                                                                        ║
  377.  ║                  OK  ▄              Cancel                             ║
  378.  ║                 ▀▀▀▀▀▀              ▀▀▀▀▀▀                             ║
  379.  ║                                                                        ║
  380.  ╚════════════════════════════════════════════════════════════════════════╝
  381.  
  382.   The author enters a text description of the issue as a possible
  383.   outcome to be voted on as true or false (or in the case of a
  384.   selection issue, the author describes the range of possible
  385.   selections and their numeric assignments).
  386.  
  387.   The author may mark the issue as private in which case it will be
  388.   accessible only to those voters specified by the author (see
  389.   invitations below) and the program manager.
  390.  
  391.   The author may mark the issue as secret in which case individual
  392.   votes are not displayable for the issue.
  393.  
  394.   The author must select a type for the issue.  For the selection type,
  395.   multiple outcomes are allowed and should be enumerated in the issue
  396.   description text.
  397.  
  398.   The author must enter an end date after which issues cannot be entered.
  399.   The settlement date when the referee ajudicates the issue defaults to
  400.   the end date but can be edited to a later date if desired.  The start
  401.   date when issues can first be entered defaults to the current date but
  402.   again can be edited to a later date if desired.
  403.  
  404.   When ENTER or the OK button are pressed, the author is presented with
  405.   further dialogs depending on the nature of the issue created:
  406.  
  407.  
  408.   2.6.2 - Referee selection
  409.  
  410.   First a pick list of voters is presented for selection of the referee.
  411.   Note that a referee must have referee privilege to be eligible.  The
  412.   referee will ajudicate the issue when the settlement date arrives.  The
  413.   referee may also edit or cancel the issue at any time.  An author can
  414.   choose him or herself as referee if so privileged.
  415.  
  416.   2.6.3 - Selection size entry
  417.  
  418.   If Selection type is selected then the following dialog is presented:
  419.  
  420.         ╔═[■]════════════════Selection Size ═══════════════════════╗
  421.         ║    How many outcomes are possible? (max 365)             ║
  422.         ║    1                                                     ║
  423.         ║                                                          ║
  424.         ║    How many votes per voter?                             ║
  425.         ║    1                                                     ║
  426.         ║                                                          ║
  427.         ║                                                          ║
  428.         ║                                                          ║
  429.         ║                                                          ║
  430.         ║              OK  ▄                                       ║
  431.         ║             ▀▀▀▀▀▀                                       ║
  432.         ║                                                          ║
  433.         ╚══════════════════════════════════════════════════════════╝
  434.  
  435.   The author enters the number of outcomes and the number of votes per
  436.   voter on this issue.
  437.  
  438.  
  439.   2.6.4 - Invitations
  440.  
  441.   Finally the author is presented with a list of all voters on the
  442.   system from which voters can be selected.  Any voters selected
  443.   will be issued invitations for that issue and will have a slot
  444.   reserved in the voters list.  If the issue was marked private, only
  445.   those invited may vote.  Otherwise anybody may.
  446.  
  447.  
  448.   2.7 - ISSUES DISPLAY
  449.  
  450.   Simple Yes/no issues are displayed as follows:
  451.  
  452. ╔═[■]═════════════════════════ Display an Issue ═════════════════════════════╗
  453. ║       {Public,Private} <category> #n by <author>                           
  454. ║                                                                            ▓
  455. ║   Votes may be cast from <start date> to <close date>                      ▓
  456. ║   The issue will be settled on <settle date> by referee                    ▓
  457. ║   Votes are to be cast in support of or against the following outcome:     ▓
  458. ║  ┌────────────────────────────────────────────────────────────┐            ▓
  459. ║  │<outcome - a description of the issue as a possible outcome │    Tally ▄ ▓
  460. ║  │                                                            │    ▀▀▀▀▀▀▀ ▓
  461. ║  │                                                            │            ▓
  462. ║  │                                                            │    Next  ▄ ▓
  463. ║  └────────────────────────────────────────────────────────────┘    ▀▀▀▀▀▀▀ ▓
  464. ║                                                                            ▓
  465. ║   n ayes have have been cast, and n nays.                                  ▓
  466. ║                                                                            ▓
  467. ║   You have voted {'Aye','Nay'}.                                   Vote     ▓
  468. ║                                                               () Skip     ▓
  469. ║                                                               ( ) Yes      ▓
  470. ║                                                               ( ) No       ▓
  471. ║                                                               ( ) Cancel   ▓
  472. ║                                                                            
  473. ╚════════════════════════════════════════════════════════════════════════════╝
  474.  
  475.   If the issue is open, the user may TAB to the Vote radio buttons
  476.   to enter a vote for or against the outcome.
  477.  
  478.   The Tally button may be pressed to display a list of the voters
  479.   and their votes on this issue.  (Not available if the issue is marked
  480.   secret and user is not program manager.)
  481.  
  482.   Selection issues are displayed as follows:
  483.  
  484. ╔═[■]═════════════════════════ Display an Issue ═════════════════════════════╗
  485. ║        {Public,Private} <category> #<n> by <author>                        
  486. ║                                                                            ▓
  487. ║   Votes may be cast from <start date> to <close date>                      ▓
  488. ║   The issue will be settled on <settle date> by referee                    ▓
  489. ║   Votes are to be cast in support of one of the following outcomes:        ▓
  490. ║  ┌────────────────────────────────────────────────────────────┐            ▓
  491. ║  │This is a Selection test                                    │    Tally ▄ ▓
  492. ║  │                                                            │    ▀▀▀▀▀▀▀ ▓
  493. ║  │                                                            │            ▓
  494. ║  │                                                            │    Next  ▄ ▓
  495. ║  └────────────────────────────────────────────────────────────┘    ▀▀▀▀▀▀▀ ▓
  496. ║   Each voter has n votes.  There are nn possible outcomes.                 ▓
  497. ║   You may select n outcomes.                Choice #Votes                  ▓
  498. ║                                               NO VOTE                      ▓
  499. ║   n votes have been placed.                  01    0                       ▓
  500. ║   You have n votes remaining.                02    0                       ▓
  501. ║                                              03    0                       ▓
  502. ║                                              04    0                       ▓
  503. ║                                              05    0                       ▓
  504. ║                                              06    0                       
  505. ╚════════════════════════════════════════════════════════════════════════════╝
  506.  
  507.   If the issue is open, the user may TAB to the Choice pick-list and
  508.   select an outcome number from the list.
  509.  
  510.  
  511.   2.8 - REFEREE AN ISSUE
  512.  
  513.   A refereed issue is displayed with a radio button selection as follows:
  514.  
  515.                         () Skip
  516.                         ( ) Yes
  517.                         ( ) No
  518.                         ( ) Cancel
  519.  
  520.   In all cases except skip, the issue is moved to the Settled list
  521.   where it remains until a newly created issue overwrites it.  The
  522.   last 10 settled issues can be displayed.  In the case of a selection
  523.   issue, the referee is also presented with the outcome pick-list from
  524.   which the winner is selected.
  525.  
  526.   An Edit button also appears to allow the referee to alter the issue.
  527.  
  528.   To settle a selection issue, the referee selects the winner from the pick-
  529.   list and presses the Yes radio button.
  530.  
  531.  
  532.   2.9 - VOTERS MENU
  533.  
  534.   The Voters Menu has two selections:
  535.  
  536.                  ┌───────────────────┐
  537.                  │Display            │
  538.                  │Edit               │
  539.                  └───────────────────┘
  540.  
  541.   Either presents a pick-list of all voters on the system.  When
  542.   a voter is selected, the following dialog appears:
  543.  
  544.        ╔═[■]═══{Display,Edit} Voter Info ═════════════════╗
  545.        ║                                                  ║
  546.        ║    Name      :   <account name>                  ║
  547.        ║                                                  ║
  548.        ║    Password  :   <password>                      ║
  549.        ║                                                  ║
  550.        ║    Privilege:                                    ║
  551.        ║        [X] Create Issues                         ║
  552.        ║        [X] Create Categories                     ║
  553.        ║        [X] Referee                               ║
  554.        ║        [X] Accounts Manager                      ║
  555.        ║        [X] Program Manager                       ║
  556.        ║                                                  ║
  557.        ║            Cancel ▄            OK     ▄          ║
  558.        ║            ▀▀▀▀▀▀▀▀            ▀▀▀▀▀▀▀▀          ║
  559.        ║                                                  ║
  560.        ╚══════════════════════════════════════════════════╝
  561.  
  562.   All values may be altered in the edit selection but edit is available
  563.   only to accounts with Accounts Manager or Program Manager privilege.
  564.   Passwords are only displayed to the Program Manager.
  565.  
  566.   2.10 - HELP MENU
  567.  
  568.   The Help Menu has two selections:
  569.  
  570.                  ┌───────────────────┐
  571.                  │File            F1 │
  572.                  │About              │
  573.                  └───────────────────┘
  574.  
  575.   File displays a window with this file in it.  F1 is a hot key for
  576.   this selection.
  577.  
  578.   About presents a window with the current version number of the program.
  579.  
  580.